The Atari Compendium

home *** CD-ROM | disk | FTP | other *** search

/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / shdwterm.arc / DOC / SHDWTERM.TXT

Wrap

Text File | 1992-07-09 | 24.8 KB | 631 lines

ShadowTerm II Copyright 1992, Michel Forget July 1st, 1992 [ CANADA DAY ] Introduction -=-=-=-=-=-= Welcome to ShadowTerm II, the newest (and best) terminal program available for the Atari ST! Over the last several years, there have been many Shareware and public domain terminal programs available for the Atari ST series of computers. They all claimed to meet the special needs of the user. Some of them were able to come through on this claim, but most fell short in several key areas, such as: a) the user interface Do you hate muddled, non-standard user interfaces? I do. ShadowTerm II provides a crisp, clean, and direct menu-driven user interface. Each command *ALSO* has an easy-to-remember keystroke equivalent so that the expert user can move through the program with ease and speed. b) program functionality Some programs do one thing extremely well, and completely neglect other important functions. ShadowTerm II does nearly everything you could ever want! It has a host of disk functions, an exceptional dialing interface, a wide range of terminal mode commands not found in any other terminal program, a comprehensive viewing buffer, a great file transfer front-end, a facility that will allow you to have your computer perform logon sequences for you, and even a special interface that allows you to run up to ten programs with a single keystroke! That is only half of what ShadowTerm II can do for you! c) ability to do what it claims to do They say that humility is good for the soul. I'm not so sure about that, but I am sure that there are certain programming feats that I am simply not able to perform. While developing ShadowTerm II, I had to make a hard choice; do it all myself, or make use of available facilities. Since I wanted ShadowTerm II to perform all functions as well as possible, I decided to follow the latter method. That is why ShadowTerm II uses the excellent XYZ external transfer protocol written by Alan Hamilton of Starfall Software and the superb Ymodem-G external transfer protocol from Zipline software. Note: ShadowTerm II does all the work of calling XYZ and Ymodem-G. All you have to do is choose a transfer protocol and then choose the file(s) using the file selector. Shareware! -=-=-=-=-= Now that you have a general idea what ShadowTerm II can do for you, I feel that I should mention the price before continuing: \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ ** S P E C I A L O F F E R ** //////////////////////////////////////////// If you register ShadowTerm II, you will not only receive a completely operational version of ShadowTerm II, but you will *ALSO* receive an accessory version of the online notepad, a small auto-folder program that will keep track of the date (and set it) for you, the Personal Pascal source code for the date program, a utility that will help you edit ShadowTerm II data files, and your next update for ShadowTerm II will only cost you $10. Can you beat that? An unrestricted version of the program, three VERY useful pieces of software, some source code, and a discount on the next release of ShadowTerm II! I must be crazy to offer this kind of deal! To register yourself, you must send $15 to: Michel Forget 207 Rivercrest Crescent St. Albert, Alberta T8N 3B9 CANADA What a deal! Commercial programs that do much less than ShadowTerm II often cost far more. I'll even make you a better deal! If you upload this archive to an Atari BBS or a BBS with an Atari section, I'll take $2 off the price of registration. Note: You have to provide proof, like a printed excerpt from the file listing of the BBS concerned, showing that the file was indeed uploaded. Doom & Gloom -=-=-=-=-=-= I hate to have to say this, but if nobody bothers to register, the Shareware concept will die. I have spoken to many authors of fine programs who received not one registration for their hard work. Most of them stopped writing for the ST. So please support the Atari ST Shareware market by registering this program (and take advantage of the deal I mentioned above). If you take the time to consider it, $15 is not much to ask for seven months of hard work, is it? ShadowTerm II Demonstration Notes -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- There has been one limitation imposed upon the demonstration of ShadowTerm II; a thirty minute time limit. The timer starts counting the first time you enter terminal mode. I can honestly say that I *hate* being forced to impose limits on ShadowTerm II, but it has been my experience that most people who can use a program without any restrictions tend not to send the Shareware fee to the author. If you register, there are benefits! The registered version of ShadowTerm II will be up-to-date, and will have as many new features as I can think of. Not to mention the free software, the source code, and the discount. This demo comes ready to use on drive A. You can move it, of course, but you will have to edit the configuration file to do so. The registered version of ShadowTerm II comes with a program to do this for you. System Requirements -=-=-=-=-=-=-=-=-=- ShadowTerm II uses about 381K of memory, and only about 193K on disk (even less if you Pack it or Squishh it), so it should run on any Atari ST, STe, or TT. I do not own an STe, or a TT, so this can only be verified by you, the user. ShadowTerm II runs in medium or high resolution, depending on your preferences. The file size of ShadowTerm II can be cut in half (or better) by using a compression program such as PFX Pack or DC Squish on it. Disclaimer -=-=-=-=-= ShadowTerm II does not come with any warranty, express or implied. You use ShadowTerm II at your own risk. Neither the author of ShadowTerm II (Michel Forget) nor any other party is responsible for any equipment damage, data loss, or other unforseen consequence of of the use or mis-use of ShadowTerm II. Starting ShadowTerm II -=-=-=-=-=-=-=-=-=-=-= To start ShadowTerm II, simply unpack the archive and double-click on SHDWTERM.PRG! It is that simple. Using This Manual -=-=-=-=-=-=-=-=- ShadowTerm II is not hard to use by any means. There are some ideas and functions that bear explanation, though. Therefore, I will list all of the menu options below, and then explain the options and features that need to be explained. Obviously, some need no explanation at all. For example, using the the "Copy File" command is merely a matter of telling ShadowTerm II the source and destination. The Menu (General Overview) -=-=-=-=-=-=-=-=-=-=-=-=-=- Desk ---- ShadowTerm II File ---- Load Configuration Save Configuration Locate System Files Execution Profile Macro Key Profile Execute File Show Free Memory Quit Disk ---- Copy File Move File Delete File Rename File Print File Touch File Append File Create Folder Delete Folder Show Free Space File Selector Buffer ------ Open Buffer Window Close Buffer Window Write Buffer Clear Buffer Show Buffer Status Change Buffer Size Initially Active Buffer Active Buffer Save Query Phone ----- Telephone Dialer Show Quick Dial Access Hang Up Idle Line Serial Port Modem Commands/Strings Terminal Mode General ------- Download File Upload File Send ASCII File Create Sequence File Create Wait Sequence Status Bar Set Time & Date The Menu (Detailed Descriptions) -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= Load & Save Configuration -=-=-=-=-=-=-=-=-=-=-=-=- The configuration file is the file that stores all of the information used by ShadowTerm II. You can have as many configuration files as you want, but you must have one called SHDWTERM.CNF, since that is the configuration file ShadowTerm II loads at start-up. Locate System Files -=-=-=-=-=-=-=-=-=- When you first uncompress the ShadowTerm II archive, all the files are placed in a organized directory tree. If you would like to change the directory structure, you can set it up as you like it, and then click on "Locate System Files" under the File menu. Locate the files in their new positions as prompted, and you are done! You can change the location of the Script Module, the two transfer modules, and the directory for sequence files. If you have already changed the location of a system file or do not want to change the location of a system file, selecting CANCEL from the file selector will have the program prompt you for the next file location without changing the current one. The Execution Profile Editor -=-=-=-=-=-=-=-=-=-=-=-=-=-= The Execution Profile Editor allows you to tell ShadowTerm II to execute a certain file with a single keypress, and it also allows you to enter a description for the file. To enter the Execution Profile Editor, select "Execution Profile" from under the "File" menu. You will be presented with a dialog box that has a row of buttons (labelled 1, 2, 3, 4, 5, 6, 7, 8, 9, and 0) running horizontally at the top of the screen, and a list of ten blank lines placed vertically inside a white box. The white box is called the description list, and it is simply there to tell you what keypresses activate what files. Clicking on one of the buttons in the top row will bring up the standard file selector. After choosing an executable file, you will be asked to enter a description for the file. After entering the description, press the return key or click on the "Done" button. You will be returned to the Execution Profile Editor. If you look at the description list, you will see that the description you entered for the file is now shown beside the number that corresponds to the button you clicked on. From now on, whether you are in terminal mode or at the menu, you can hold down the control key and press the number that appears beside the description whenever you want the file to be executed. What could be easier? The Macro Key Profile -=-=-=-=-=-=-=-=-=-=- Most users are fammilliar with macro (function) keys. They are simply shortcuts. One keypress can be used to send an entire string of characters. This is especially useful for names, passwords, and signatures. ShadowTerm II allows you to have up to thirty macro keys! To enter the Macro Key Profile Editor, simply click on "Macro Key Profile" under the "File" menu. The three buttons at the bottom of the dialog box you are presented with determine which set of macro keys you are editing. You can switch between the sets by clicking on one of the three buttons. When you are done editing your function keys, simply click on "Done". When you are in terminal mode, and want to send one of the macros, just hold down the correct key (Alternate, Shift, or Control) and press the function key that corresponds to the macro you want to send. The Telephone Dialer -=-=-=-=-=-=-=-=-=-= The Telephone Dialer is one of the most exciting features about ShadowTerm II. Why? Because it does everything! To enter the Telephone Dialer, click on "Telephone Dialer" under the "Phone" menu. You will be presented with a dialog box. In the upper right-hand corner of the dialog box, there is a small button that shows which of the twenty BBS entries you are currently working with. Clicking on this box will bring up another dialog, allowing you to jump to any other entry (simply by clicking on the name of the entry you wish to jump to). Or, if you want to move one entry forward or backward, click on the buttons showing an arrow. ShadowTerm II keeps detailed information about each entry! The name, phone number are the most important, of course. ShadowTerm II also keeps track of the baud rate, three lines of comments, whether or not the BBS is long distance, whether or not the BBS has an Auto Entry Sequence (more on that later), and lastly whether or not the BBS will be dialed by the group dialer. That may seem like a lot of information for you to enter, but it actually isn't. It only takes a few seconds. The name of the BBS, number, baud rate, and comment lines are editable fields that you must type in. If the BBS is long-distance, click on the "LD" button. If you want the BBS to be dialed by the group dialer, click on the "GROUP" button. If you want ShadowTerm II to perform your logon for you (this is called an Auto Entry Sequence and will be dealt with later in this document) then click on the "Auto" button. That is all there is to it! Dialing is even easier. To dial the current entry, click on "Dial Current". If you want ShadowTerm II to Autodial the current entry, make sure you click on "AutoDial" first. You can turn Autodialing off by clicking "AutoDial" again. To abort a dialing operation, hold down either one of the mouse buttons. ShadowTerm II also has a group dialer. The group dialer takes a group of entries, and dials each one in succession until a connection is made to one of the entries in the group. This can be really useful if most of the places you call are busy. The Quick Dial Access -=-=-=-=-=-=-=-=-=-=- If you are at the menu, you can dial any one of the first ten entries in the Telephone Dialer by holding down the Alternate key and pressing one of number keys. 1=Entry #1, 2=Entry #2, ..., 0=Entry #10. You can see which entries can be accessed using this method by clicking on "Show Quick Dial Access" under the "Phone" menu. Create Sequence File & Create Wait Sequence -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- One of the most often used features of ShadowTerm II is the Auto Entry Sequence. Why? It allows you to tell ShadowTerm II to automatically perform a logon sequence for you. Once you tell ShadowTerm II what strings to look for, and what strings to reply with, you will never have to go through the boring procedure of logging onto a BBS again. ShadowTerm II will do it for you! To set up a sequence file, you should follow this method: A. Call the BBS and write down every prompt it gives you during the logon process. Example: The FoReM/Turbo prompts are usually: [Note: Prompts are only partial strings, since you do not need the entire string. You only need enough of the string so that it can be recognized. The strings are surrounded by quotation marks so that you can see the spaces. SPACES, PUNCTUATION, and CAPATALIZATION are vital. *THE STRINGS MUST BE EXACT.*] 'Return' 'User)> ' 'word: ' 'Exit)> ' The last string in the above list is only needed if the BBS system shows you a list of bulletins. Some systems have slightly different prompts, so be very careful. B. Click on "Create Sequence File" under the "General" menu. C. Click on the name of the BBS you just called. D. You will be presented with a dialog box. The name of the BBS you are working with appear is in a small box in the upper-left hand corner of the screen. Enter the first prompt you wrote down in slot #1 under the "Search:" column. Then, enter the response to the prompt in slot #1 under the "Send:" column. Go down through the list until you have no more prompts to reply to. There are two special cases: 1. If you want to send a return, you should enter the "|" symbol by holding down the shift key, and pressing the "\" key which is located directly under the "Delete" key. 2. If you want to send an escape, you should enter the "`" symbol by pressing the key directly to the left of the "Backspace" key. E. When you are done, click on "Done" and the file will be saved. F. Enter the Telephone Dialer, move to the BBS you created the sequence file for, and click on the "Auto" button so that is becomes selected. G. Make sure you save your configuration! That way ShadowTerm II will remember that there is an Auto Entry Sequence File for that BBS. A Wait Sequence is much like a sequence file. You create it in exactly the same fashion as a Sequence File, but a Wait Sequence is used when you are not online. The telephone company is offering new and betetr features every day. In my neck of the woods, I can tell the telephone to monitor up to three different phone numbers so that I will get through when the line becomes free. The phone alerts me by ringing, and the modem sends the RING string to the computer. All I have to do is send "ATD|" to the modem and I will connect to the BBS I am waiting for. To make things faster and easier, I gave ShadowTerm II the ability to wait for the modem to send a certain string and reply. I set up the Wait Sequence to search for "RING" and reply with "ATD|". Then, when I want the computer to start waiting, I simply press Control-W from Terminal mode. This can be a really handy feature. IMPORTANT NOTE: If, for some reason, an Auto Entry Sequence or a Wait sequence gets locked up, hold either mouse button to abort. This sometimes happens. ShadowTerm II will dump all of the replies to the modem and then drop you into terminal mode. The Buffer Window -=-=-=-=-=-=-=-=- When the buffer window is open, a number of keystrokes are used to move around within it: Up Arrow = Up One Line Down Arrow = Down One Line Shift + Up Arrow = Up One Page Shift + Down Arrow = Down One Page Clr Home = Move To Top Of Buffer Shift + Clr Home = Move To Bottom Of Buffer Insert = Jump To Line You can press the HELP key to get a list of buffer window commands while you are at the menu. Terminal Mode -=-=-=-=-=-=- When you are in terminal mode, there are a number of commands at your disposal: Control + U = Show Time/Date Control + V = Show Status Control + O = Time Online Alternate + G = Download File Alternate + I = Upload File Control + H = Hang Up Control + D = Send Date Control + T = Send Time Control + N = Enter Online Notepad Control + W = Wait Mode Control + R = Send Random Postscript The Terminal Mode also has one unlisted command. In medium resolution, there is a bug in Personal Pascal or ShadowTerm II that prevents the proper positioning of the cursor in certain situations. THIS ONLY HAPPENS IN MEDIUM RESOLUTION! If you see that the cursor has inexplicably moved to the top left-hand corner of the screen, press Control-P. Then you can use the arrow keys to move the cursor to the correct position. When it is where you want it, press the insert key. The Online Notepad -=-=-=-=-=-=-=-=-= When you are online, you may find you want to make a note of something. With ShadowTerm II, this is simple. Just hold down the Cotnrol key and press the letter N. You will be presented with a dialog box that has seven items of interest: 1. In the center of the dialog box, there is a large white box containing a group of fifteen blank lines. All of the lines are editable fields that you can use for your notes. 2. Inside the box with editable fields, there is a row of vertically placed numbers ranging from one to fifteen. Each of these can be selected when clicked on. They are used to mark which lines the notepad functions will affect when they are used. 3. In the upper-right hand corner of the dialog box, there is a smaller box that tells you what page of the Online Notepad you are currently working with. To move to the next page, click on this box. There are four pages. When you try to move past the fourth page, the notepad will jump to the first page again. 4-7. At the bottom of the dialog box, there are four buttons of interest. They are Clear, Save, Print, and Send. Note: If you hold down the Alternate key when selecting on any of these four buttons, the function will act on the entire page. If you do not hold down the Alternate key, the functions will affect ONLY those entry lines that you have marked using the row of selectable numbers to the left of the entry lines. Clear is used to erase entries. Save is used to save entries to disk. Print is used to print entries. Send is used to send entries to the modem. Note: You do not need to use the "|" symbol in the notepad for the send function. All entries sent to the modem are sent with a carriage return at the end of them. Editing ShadowTerm II Data Files -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= There are two data files used by ShadowTerm II that you can edit. They are the configuration file and the script file. You should use a plain ASCII text editor, or an editor that can output plain ASCII and does not try to format the file. CAUTION: DO NOT CHANGE THE LENGTH OF DATA FILES. The main reason for editing the data files is to change the pathnames used by ShadowTerm II. If you are moving the program to a different partition, this is the only way to move your data files with it (unless you buy the registered version). The ShadowTerm II configuration file also contains two "delays" that allow you to speed up or slow down certain events. The first delay is found on line three of the configuration file. It tells ShadowTerm II how long it should wait between characters when sending a macro string or sending an ASCII file. If you shorten this delay too much, you may have problems. The second delay is found on line seven of the same file. This delay tells ShadowTerm II how long to wait before re-dialing a number in AutoDial. Examples: Delay Actual Time ----- ----------- 185000 2 Seconds 92500 1 Second 46250 1/2 Second 12000 1/8 Second Comments & Suggestions & Bug Reports -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= I am *definitely* interested in hearing your comments, suggestions, and bug reports. I will be more than happy to try to implement the suggestions of registered users. I can be reached three ways: FNET: Lord Chimara @ FNET Node 595 Internet: mforget@ersys.edmonton.ab.ca Mail: Michel Forget 207 Rivercrest Crescent St. Albert, Alberta T8N 3B9 If you make a really good suggestion, and I implement it, I will send you a registered version of ShadowTerm II for only $10! The same applies if you give me an extremely detailed bug report (and I manage to fix the bug). By "extremely detailed", I mean that I must be able to duplicate the bug every time I try. Please supply an Email address (Internet or FNET) if you have one so that I can contact you. Please support the Shareware concept, and I hope you enjoy using ShadowTerm II. Michel Forget July 1st, 1992 [Canada Day]